Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added per language scope support docs #2451

Merged
merged 36 commits into from
Jul 30, 2024
Merged

Added per language scope support docs #2451

merged 36 commits into from
Jul 30, 2024

Conversation

AndreasArvidsson
Copy link
Member

@AndreasArvidsson AndreasArvidsson commented Jun 24, 2024

Checklist

  • [/] I have added tests
  • I have updated the docs and cheatsheet
  • [/] I have not broken the cheatsheet

@AndreasArvidsson
Copy link
Member Author

@pokey Looks like meta updater have some problem on windows. If I run the lint:meta script on my own computer it works fine and works fine on Linux and mac, but windows on ci is failing. Probably have something to do with line endings?

@AndreasArvidsson
Copy link
Member Author

Also I would prefer to remove the unsupported scope facet level. Since there's isn't really any difference between explicitly saying unsupported and not specifying the level at all.

@pokey
Copy link
Member

pokey commented Jun 24, 2024

I would argue for keeping unsupported. Otherwise there's no way to know if it is unspecified because it's unsupported or if we just haven't gotten around to indicating its support level yet

@AndreasArvidsson
Copy link
Member Author

Yes I'm just doubting that we are ever going to actually do that :p
But sure let's keep it for now.

@pokey
Copy link
Member

pokey commented Jun 25, 2024

Yes I'm just doubting that we are ever going to actually do that :p

Sorry not sure I'm following: doubting whether we'll do what?

@AndreasArvidsson
Copy link
Member Author

Yes I'm just doubting that we are ever going to actually do that :p

Sorry not sure I'm following: doubting whether we'll do what?

Getting around to actually going through all scope facets and specifying unsupported.

@pokey
Copy link
Member

pokey commented Jun 26, 2024

Getting around to actually going through all scope facets and specifying unsupported.

Exactly. That's why it's important to have the ability to distinguish between unsupported and just not having been specified yet. If we just take unspecified to mean it's unsupported, we won't be able to tell which ones are actually unsupported and which we just haven't gotten around to yet

@pokey
Copy link
Member

pokey commented Jun 26, 2024

Eg we could render the missing ones with a question mark in the docs to encourage people to contribute, and so they don't get the false impression it's not supported when really it is

@AndreasArvidsson
Copy link
Member Author

@pokey Any ideas how to fix the lint:meta problem on windows?

@pokey
Copy link
Member

pokey commented Jul 1, 2024

Not sure but I'm not sure it's a good idea to use meta-updater for generating this .md file anyway. My instinct would be to do that during web build step. Is there some reason to prefer checking this file into source control?

@AndreasArvidsson
Copy link
Member Author

I always prefer if documentation is in markdown. If I need to navigate to a webpage to read the docs I'm probably not gonna do it as often.

@pokey
Copy link
Member

pokey commented Jul 1, 2024

Yeah but this file is huge. Are you really going to read this file anyway? I had thought that the tables were supposed to be more for users, and that contributors would just look at the source code

@AndreasArvidsson
Copy link
Member Author

I guess that works as well. Where do you want this placed instead?

@pokey
Copy link
Member

pokey commented Jul 2, 2024

Maybe we just generate it into docs folder during website build step and add that to gitignore? That's what we used to do with our api docs

@AndreasArvidsson
Copy link
Member Author

Where do we have existing configuration for that I can look at?

@pokey
Copy link
Member

pokey commented Jul 2, 2024

I don't believe we do anything like that today. On second thought, though, we should prob do it with an MDX react component that imports the scope support tables

@AndreasArvidsson
Copy link
Member Author

That sounds reasonable. Have you done anything like that before or do you have some documentation I could look at how to do that with docusaurs?

@pokey
Copy link
Member

pokey commented Jul 2, 2024

Just Google docusaurus MDX. We have some MDX stuff in our next.js root site as well. Look for files ending in mdx

If you get stuck let's discuss at meetup

@pokey
Copy link
Member

pokey commented Jul 21, 2024

@AndreasArvidsson why did you downgrade docusaurus?

@AndreasArvidsson
Copy link
Member Author

@AndreasArvidsson why did you downgrade docusaurus?

It did not compile and I didn't aim to update docusaurus in this pull request; it's already large enough.

@pokey
Copy link
Member

pokey commented Jul 21, 2024

strange was working fine for me, but yeah agreed it's orthogonal

@pokey
Copy link
Member

pokey commented Jul 21, 2024

@AndreasArvidsson
Copy link
Member Author

strange was working fine for me, but yeah agreed it's orthogonal

Yeah if it would have worked fine I wouldn't really have cared, but I ran into major problems with pnpm and just reverting to main fixed it.

@AndreasArvidsson
Copy link
Member Author

btw wdyt of f189f12 😄

Fine with me :)

@pokey
Copy link
Member

pokey commented Jul 21, 2024

yeah confirmed it's working; doesn't appear in sidebar https://deploy-preview-2451--cursorless.netlify.app/docs/ but can go directly to page so it is still deploying eg https://deploy-preview-2451--cursorless.netlify.app/docs/user/languages/cpp/

@AndreasArvidsson
Copy link
Member Author

Nice. I'm happy with that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love this representation, but no point in trying to get it perfect before we actually show it to users; happy to have this as a placeholder for now. The important thing about this PR imo is that we're now able to access common from .mdx files in our docs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly

Copy link
Member

@pokey pokey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. i fixed a bunch of broken links. see #2609 for the future because we should really catch those 😅

@AndreasArvidsson
Copy link
Member Author

Totally agree!

@pokey pokey added this pull request to the merge queue Jul 30, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 30, 2024
@pokey pokey added this pull request to the merge queue Jul 30, 2024
Merged via the queue into main with commit bc82122 Jul 30, 2024
15 checks passed
@pokey pokey deleted the scopeSupportDocs branch July 30, 2024 15:12
@pokey pokey mentioned this pull request Aug 4, 2024
4 tasks
@pokey pokey mentioned this pull request Oct 16, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants